/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup FFRT
 * @{
 *
 * @brief FFRT（Function Flow运行时）是支持Function Flow编程模型的软件运行时库，用于调度执行开发者基于Function Flow编程模型开发的应用。
 *
 * @since 18
 */

/**
 * @file shared_mutex.h
 *
 * @brief 声明rwlock的C接口。
 *
 * @library libffrt.z.so
 * @kit FunctionFlowRuntimeKit
 * @include <ffrt/shared_mutex.h>
 * @syscap SystemCapability.Resourceschedule.Ffrt.Core
 * @since 18
 */

#ifndef FFRT_API_C_SHARED_MUTEX_H
#define FFRT_API_C_SHARED_MUTEX_H

#include "type_def.h"

/**
 * @brief 初始化rwlock。
 *
 * @param rwlock rwlock指针。
 * @param attr rwlock属性指针，仅支持默认，即设定为空指针。
 * @return `rwlock`不为空，且`attr`为空则初始化成功，返回ffrt_success，
           反之初始化rwlock失败，返回ffrt_error_inval。
 * @since 18
 */
FFRT_C_API int ffrt_rwlock_init(ffrt_rwlock_t* rwlock, const ffrt_rwlockattr_t* attr);

/**
 * @brief 获取写锁。
 *
 * @param rwlock rwlock指针。
 * @return 获取写锁成功返回ffrt_success，
           获取写锁失败返回ffrt_error_inval或者阻塞当前任务。
 * @since 18
 */
FFRT_C_API int ffrt_rwlock_wrlock(ffrt_rwlock_t* rwlock);

/**
 * @brief 尝试获取写锁。
 *
 * @param rwlock rwlock指针。
 * @return 获取写锁成功返回ffrt_success，
           获取写锁失败返回ffrt_error_inval或ffrt_error_busy。
 * @since 18
 */
FFRT_C_API int ffrt_rwlock_trywrlock(ffrt_rwlock_t* rwlock);

/**
 * @brief 获取读锁。
 *
 * @param rwlock rwlock指针。
 * @return 获取读锁成功返回ffrt_success，
           获取读锁失败返回ffrt_error_inval或者阻塞当前任务。
 * @since 18
 */
FFRT_C_API int ffrt_rwlock_rdlock(ffrt_rwlock_t* rwlock);

/**
 * @brief 尝试获取读锁。
 *
 * @param rwlock rwlock指针。
 * @return 获取读锁成功返回ffrt_success，
           获取读锁失败返回ffrt_error_inval或ffrt_error_busy。
 * @since 18
 */
FFRT_C_API int ffrt_rwlock_tryrdlock(ffrt_rwlock_t* rwlock);

/**
 * @brief 释放rwlock。
 *
 * @param rwlock rwlock指针。
 * @return 释放rwlock成功返回ffrt_success，
           释放rwlock失败返回ffrt_error_inval。
 * @since 18
 */
FFRT_C_API int ffrt_rwlock_unlock(ffrt_rwlock_t* rwlock);

/**
 * @brief 销毁rwlock。
 *
 * @param rwlock rwlock指针。
 * @return 销毁rwlock成功返回ffrt_success，
           销毁rwlock失败返回ffrt_error_inval。
 * @since 18
 */
FFRT_C_API int ffrt_rwlock_destroy(ffrt_rwlock_t* rwlock);

#endif // FFRT_API_C_SHARED_MUTEX_H
/** @} */